org.eclipse.vtp.framework.common
Interface IDataType

All Known Implementing Classes:

CustomDataType

public interface IDataType

Describes a type of dynamic data object.

Author:

Lonnie Pryor

Method Summary

java.lang.String	getFieldInitialValue(java.lang.String fieldName) Returns the initial value for new instances of the specified field.
java.lang.String[]	getFieldNames() Returns the names of the fields that objects of this type support.
IDataType	getFieldType(java.lang.String fieldName) Returns the type of the specified field or null if no such field exists.
java.lang.String	getName() Returns the unique name of this type.
java.lang.String	getPrimaryFieldName() Returns the name of the field that objects of this type treat as their primary value or null if no such field is defined.
boolean	isArrayType() Returns true if this type represents an array type.
boolean	isComplexType() Returns true if this type represents a type with named fields.
boolean	isSimpleType() Returns true if this type represents a boolean, date, decimal, number, or string type.

Method Detail

getName

java.lang.String getName()

Returns the unique name of this type.

Returns:

The unique name of this type.

getFieldNames

java.lang.String[] getFieldNames()

Returns the names of the fields that objects of this type support.

Returns:

The names of the fields that objects of this type support.

getPrimaryFieldName

java.lang.String getPrimaryFieldName()

Returns the name of the field that objects of this type treat as their primary value or null if no such field is defined.

Returns:

The name of the field that objects of this type treat as their primary value if no such field is defined.

getFieldType

IDataType getFieldType(java.lang.String fieldName)

Returns the type of the specified field or null if no such field exists.

Parameters:

fieldName - The name of the field to determine the type of.

Returns:

The type of the specified field or null if no such field exists.

getFieldInitialValue

java.lang.String getFieldInitialValue(java.lang.String fieldName)

Returns the initial value for new instances of the specified field.

Parameters:

fieldName - The name of the field to determine the initial value of.

Returns:

The initial value for new instances of the specified field.

isArrayType

boolean isArrayType()

Returns true if this type represents an array type.

Returns:

True if this type represents an array type.

isComplexType

boolean isComplexType()

Returns true if this type represents a type with named fields.

Returns:

True if this type represents a type with named fields.

isSimpleType

boolean isSimpleType()

Returns true if this type represents a boolean, date, decimal, number, or string type.

Returns:

True if this type represents a boolean, date, decimal, number, or string type.